Get User ExtraField List

GET : http://<base_url>/digipay/v3/user/document_type

This API is used to get a user extra field detail list

QUERY PARAMS:-

Parameter	Type	Description	Value
field_type	Int	An integer representing the field type, set to 1. The actual meanings of field types would depend on the application's domain.	2
is_mandatory	Boolean	A boolean flag indicating whether the document is mandatory.	true/false
user_type	Int	An integer representing the user type associated with the field, set to 2.	2
dynamic_category_key	String	A key that dynamically links documents to specific categories.	dynamic_key
display_order	strings	An integer indicating the display order of the field, set to 5.	123
is_default	Boolean	A boolean flag indicating whether an expiry date is required for the document."	true/false
parent_field_key	Strings	A key representing the parent field, set as ""parent_key".	1213
is_active	Boolean	if value is true it will show active languages in response, if value is false it will show inActive langauages in response	true/false
skip	Int	Skip the first n document from the query result	1
limit	Int	Limits the number of records or documents that you want	1
start_date	Long	unix timestamp value in second	1
end_date	Long	unix timestamp value in second	1
sorting	String	Sorting of the Data in the form of a string	123
search_keyword	String	a keyword which can be either name of language or a language code to get desired language as output	123

HEADERS:-

Parameter	Type	Description	Value
Authorization	String	It is a combination of type and token to authenticate user for the given token	Token duik7309njdlkhdauhknksadhjkas986876sd873j
CompanyID	String	Company_id is a unique primary id, that is represent company detail	76bc712200ca444fa334f9e55e5fd7a8

Request Body:-

Request Example
curl --request GET \
     --url 'http://192.168.1.102:8014/digipay/v3/user/user_extra_field?user_type=2&field_type=2&is_default=false&is_mandatory=false&dynamic_category_key=123&parent_field_key=1213&is_active=false&skip=1&limit=1&start_date=1&end_date=1&sorting=123&search_keyword=123' \
     --header 'Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI2NWY0ZDI1MDliZmU0NTBmYTg4MTVhNTU5Njk3YmM0NyIsInJvbGVzIjpbIlJPTEVfQURNSU4iXSwiZXhwIjoxNjkzNTIxOTU1fQ.9oWwUzlFzmYB1ZOhaVamxKJH6DsMO8tFue2kbg2YyoI' \
     --header 'CompanyID: Company_id is a unique primary id, that is represent company detail.' \
     --header 'accept: application/json'

Response:-

Response 200(OK)

{
  "success": 1,
  "error": [],
  "data": {
    "user_extra_field": {
      "id": "2191e668d3794f50b8fe63c3a6556c55",
      "field_title": "Expiry Date",
      "field_type": 2,
      "field_description": null,
      "is_mandatory": true,
      "user_type": 3,
      "field_key": "expiry_date",
      "extra_field_key": "age_exp_date",
      "user_extrafield_type": 1,
      "category_key": "key1",
      "is_default": false,
      "display_order": 1,
      "field_validation": [
        {
          "key": "min_length",
          "value": "10"
        },
        {
          "key": "max_length",
          "value": "10"
        }
      ]
    }
  }
}

Response 400(BAD REQUEST)
{
    "success": 0,
    "error"": [1],
    "data": {
        "message": "BAD_REQUEST",
     }
}

RESPONSES :-

Status Code	Description
200	OK
400	BAD REQUEST
404	NOT FOUND
500	INTERNAL SERVER ERROR